Bug 327582 – Incomplete docs for GtkSettings::gtk-icon-sizes

2008-07-06  Matthias Clasen  <mclasen@redhat.com>

        Bug 327582 – Incomplete docs for GtkSettings::gtk-icon-sizes

        * gtk/gtksettings.c: Improve the documentation of the
        gtk-icon-sizes setting. Proposed by Tommi Komulainen.

svn path=/trunk/; revision=20790

diff --git a/ChangeLog b/ChangeLog
index a348946ab97101f88a230c57aa77772583d21efc..a677ffba5e08316cb454735431f1f2e1aa63bbb6 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-07-06  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 327582 – Incomplete docs for GtkSettings::gtk-icon-sizes
+       
+       * gtk/gtksettings.c: Improve the documentation of the
+       gtk-icon-sizes setting. Proposed by Tommi Komulainen.
+
 2008-07-06  Matthias Clasen  <mclasen@redhat.com>
 
        Bug 539248 – gtk_calender_query_tooltip calls ->detail_func with

diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index 7652cacfd2da96bdb14cc227e77f9b4299d5776b..47c3c942ece05b660f823a73f7804e38e0554a47 100644 (file)
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -342,6 +342,20 @@ gtk_settings_class_init (GtkSettingsClass *class)
                                              NULL);
   g_assert (result == PROP_FONT_NAME);
 
+  /**
+   * GtkSettings:gtk-icon-sizes:
+   *
+   * A list of icon sizes. The list is separated by colons, and
+   * item has the form:
+   *
+   * <replaceable>size-name</replaceable> = <replaceable>width</replaceable> , <replaceable>height</replaceable>
+   *
+   * E.g. "gtk-menu=16,16:gtk-button=20,20:gtk-dialog=48,48". 
+   * GTK+ itself use the following named icon sizes: gtk-menu, 
+   * gtk-button, gtk-small-toolbar, gtk-large-toolbar, gtk-dnd, 
+   * gtk-dialog. Applications can register their own named icon 
+   * sizes with gtk_icon_size_register().
+   */
   result = settings_install_property_parser (class,
                                              g_param_spec_string ("gtk-icon-sizes",
                                                                   P_("Icon Sizes"),